Skip to main content

Enable / Disable User API

These endpoints are used to enable or disable a specific user within the business application. Both endpoints use the POST method and require a valid apikey and email as query parameters.

1. Enable User​

Enables a previously disabled user in the business system.

API Endpoint​

api/v1/business/user/{userId}/enable?apikey=<API_KEY>&email=<EMAIL>

  • Method: POST
  • Path Parameter:
    • userId — Unique identifier of the user to enable
  • Query Parameters:
    • apikey: Your API key(required)
    • email: Email ID of the user(required)

Request Syntax​

POST api/v1/business/user/enable/{userId}?apikey=<API_KEY>&email=<EMAIL>

Example​

Sample Request​

curl --location --globoff --request POST 'https://alb-backend.msgkart.com/api/v1/business/user/{{userId}}/enable?apikey=<API KEY>&email=<EMAIL ID>'

Response​

Response is a success message i.e, User enabled successfully

  • HTTP Status Code: 200 OK (successful), 4xx/5xx (error)
  • Response Body: JSON object containing user status details.

2. Disable User​

Disables a specific user, preventing them from accessing business features.

API Endpoint​

api/v1/business/user/{userId}/disable?apikey=<API_KEY>&email=<EMAIL>

  • Method: POST
  • Path Parameter:
    • userId — Unique identifier of the user to enable
  • Query Parameters:
    • apikey: Your API key(required)
    • email: Email ID of the user(required)

Request Syntax​

POST /api/v1/business/user/disable/{userId}?apikey=<API_KEY>&email=<EMAIL>

Example​

Sample Request​

curl --location --globoff --request POST 'https://alb-backend.msgkart.com/api/v1/business/user/{{userId}}/disable?apikey=<API KEY>&email=<EMAIL ID>'

Response​

Response is a success message i.e, User disabled successfully.

  • HTTP Status Code: 200 OK (successful), 4xx/5xx (error)
  • Response Body: JSON object containing user status details.

Error Handling​

  • Invalid credentials: 401 Unauthorized
  • Missing/invalid parameters: 400 Bad Request
  • Internal server error: 500 Internal Server Error